<!DOCTYPE html
  PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
  "DTD/xhtml1-strict.dtd">
<html>
  <head>
    <title>volatility.plugins.linux.common.AbstractLinuxCommand : API documentation</title>
    <meta content="text/html;charset=utf-8" http-equiv="Content-Type" />
    <link href="apidocs.css" type="text/css" rel="stylesheet" />
    
    
  </head>
  <body>
    <h1 class="class">v.p.l.c.AbstractLinuxCommand(<a href="volatility.commands.Command.html">commands.Command</a>) : class documentation</h1>
    <p>
      <span id="part">Part of <a href="volatility.html">volatility</a>.<a href="volatility.plugins.html">plugins</a>.<a href="volatility.plugins.linux.html">linux</a>.<a href="volatility.plugins.linux.common.html">common</a></span>
      
      <a href="classIndex.html#volatility.plugins.linux.common.AbstractLinuxCommand">View In Hierarchy</a>
    </p>
    <div>
      <p>Known subclasses: <a href="volatility.plugins.linux.arp.linux_arp.html">volatility.plugins.linux.arp.linux_arp</a>, <a href="volatility.plugins.linux.check_afinfo.linux_check_afinfo.html">volatility.plugins.linux.check_afinfo.linux_check_afinfo</a>, <a href="volatility.plugins.linux.check_fops.linux_check_fop.html">volatility.plugins.linux.check_fops.linux_check_fop</a>, <a href="volatility.plugins.linux.check_idt.linux_check_idt.html">volatility.plugins.linux.check_idt.linux_check_idt</a>, <a href="volatility.plugins.linux.check_modules.linux_check_modules.html">volatility.plugins.linux.check_modules.linux_check_modules</a>, <a href="volatility.plugins.linux.check_syscall.linux_check_syscall.html">volatility.plugins.linux.check_syscall.linux_check_syscall</a>, <a href="volatility.plugins.linux.cpuinfo.linux_cpuinfo.html">volatility.plugins.linux.cpuinfo.linux_cpuinfo</a>, <a href="volatility.plugins.linux.dentry_cache.linux_dentry_cache.html">volatility.plugins.linux.dentry_cache.linux_dentry_cache</a>, <a href="volatility.plugins.linux.dmesg.linux_dmesg.html">volatility.plugins.linux.dmesg.linux_dmesg</a>, <a href="volatility.plugins.linux.dump_map.linux_dump_map.html">volatility.plugins.linux.dump_map.linux_dump_map</a>, <a href="volatility.plugins.linux.find_file.linux_find_file.html">volatility.plugins.linux.find_file.linux_find_file</a>, <a href="volatility.plugins.linux.ifconfig.linux_ifconfig.html">volatility.plugins.linux.ifconfig.linux_ifconfig</a>, <a href="volatility.plugins.linux.iomem.linux_iomem.html">volatility.plugins.linux.iomem.linux_iomem</a>, <a href="volatility.plugins.linux.lsmod.linux_lsmod.html">volatility.plugins.linux.lsmod.linux_lsmod</a>, <a href="volatility.plugins.linux.mount.linux_mount.html">volatility.plugins.linux.mount.linux_mount</a>, <a href="volatility.plugins.linux.netstat.linux_netstat.html">volatility.plugins.linux.netstat.linux_netstat</a>, <a href="volatility.plugins.linux.pslist.linux_pslist.html">volatility.plugins.linux.pslist.linux_pslist</a>, <a href="volatility.plugins.linux.psxview.linux_psxview.html">volatility.plugins.linux.psxview.linux_psxview</a>, <a href="volatility.plugins.linux.route_cache.linux_route_cache.html">volatility.plugins.linux.route_cache.linux_route_cache</a>, <a href="volatility.plugins.linux.sk_buff_cache.linux_sk_buff_cache.html">volatility.plugins.linux.sk_buff_cache.linux_sk_buff_cache</a>, <a href="volatility.plugins.linux.slab_info.linux_slabinfo.html">volatility.plugins.linux.slab_info.linux_slabinfo</a>, <a href="volatility.plugins.linux.tmpfs.linux_tmpfs.html">volatility.plugins.linux.tmpfs.linux_tmpfs</a>, <a href="volatility.plugins.linux.vma_cache.linux_vma_cache.html">volatility.plugins.linux.vma_cache.linux_vma_cache</a></p>
    </div>
    <div class="undocumented">No class docstring</div>

    
    
    <div id="splitTables">
      <table class="children sortable" id="id1074">
  
  
<tr class="method">
    
    
    <td>Method</td>
    <td><a href="volatility.plugins.linux.common.AbstractLinuxCommand.html#__init__">__init__</a></td>
    <td><span>Constructor uses args as an initializer. It creates an instance of OptionParser, populates the options, and finally parses the command line. Options are stored in the self.opts attribute.</span></td>
  </tr><tr class="method">
    
    
    <td>Method</td>
    <td><a href="volatility.plugins.linux.common.AbstractLinuxCommand.html#profile">profile</a></td>
    <td><span class="undocumented">Undocumented</span></td>
  </tr><tr class="method">
    
    
    <td>Method</td>
    <td><a href="volatility.plugins.linux.common.AbstractLinuxCommand.html#execute">execute</a></td>
    <td><span>Executes the plugin command.</span></td>
  </tr><tr class="staticmethod">
    
    
    <td>Static Method</td>
    <td><a href="volatility.plugins.linux.common.AbstractLinuxCommand.html#is_valid_profile">is_valid_profile</a></td>
    <td><span class="undocumented">Undocumented</span></td>
  </tr><tr class="method">
    
    
    <td>Method</td>
    <td><a href="volatility.plugins.linux.common.AbstractLinuxCommand.html#get_profile_symbol">get_profile_symbol</a></td>
    <td><span class="undocumented">No summary</span></td>
  </tr><tr class="method">
    
    
    <td>Method</td>
    <td><a href="volatility.plugins.linux.common.AbstractLinuxCommand.html#get_per_cpu_symbol">get_per_cpu_symbol</a></td>
    <td><span class="undocumented">Undocumented</span></td>
  </tr><tr class="method">
    
    
    <td>Method</td>
    <td><a href="volatility.plugins.linux.common.AbstractLinuxCommand.html#get_task_start_time">get_task_start_time</a></td>
    <td><span class="undocumented">Undocumented</span></td>
  </tr><tr class="method">
    
    
    <td>Method</td>
    <td><a href="volatility.plugins.linux.common.AbstractLinuxCommand.html#online_cpus">online_cpus</a></td>
    <td><span class="undocumented">Undocumented</span></td>
  </tr><tr class="method">
    
    
    <td>Method</td>
    <td><a href="volatility.plugins.linux.common.AbstractLinuxCommand.html#walk_per_cpu_var">walk_per_cpu_var</a></td>
    <td><span class="undocumented">Undocumented</span></td>
  </tr><tr class="method">
    
    
    <td>Method</td>
    <td><a href="volatility.plugins.linux.common.AbstractLinuxCommand.html#ACTHZ">ACTHZ</a></td>
    <td><span class="undocumented">Undocumented</span></td>
  </tr><tr class="method">
    
    
    <td>Method</td>
    <td><a href="volatility.plugins.linux.common.AbstractLinuxCommand.html#SH_DIV">SH_DIV</a></td>
    <td><span class="undocumented">Undocumented</span></td>
  </tr><tr class="method">
    
    
    <td>Method</td>
    <td><a href="volatility.plugins.linux.common.AbstractLinuxCommand.html#TICK_NSEC">TICK_NSEC</a></td>
    <td><span class="undocumented">Undocumented</span></td>
  </tr><tr class="method">
    
    
    <td>Method</td>
    <td><a href="volatility.plugins.linux.common.AbstractLinuxCommand.html#get_time_vars">get_time_vars</a></td>
    <td><span>Sometime in 3.[3-5], Linux switched to a global timekeeper structure This just figures out which is in use and returns the correct variables</span></td>
  </tr><tr class="method">
    
    
    <td>Method</td>
    <td><a href="volatility.plugins.linux.common.AbstractLinuxCommand.html#get_boot_time">get_boot_time</a></td>
    <td><span class="undocumented">Undocumented</span></td>
  </tr><tr class="method">
    
    
    <td>Method</td>
    <td><a href="volatility.plugins.linux.common.AbstractLinuxCommand.html#is_known_address">is_known_address</a></td>
    <td><span class="undocumented">Undocumented</span></td>
  </tr><tr class="method">
    
    
    <td>Method</td>
    <td><a href="volatility.plugins.linux.common.AbstractLinuxCommand.html#verify_ops">verify_ops</a></td>
    <td><span class="undocumented">Undocumented</span></td>
  </tr>
  
</table>
      
        <p>
          Inherited from <a href="volatility.commands.Command.html">Command</a>:
        </p>
        <table class="children sortable" id="id1075">
  
  
<tr class="basestaticmethod">
    
    
    <td>Static Method</td>
    <td><a href="volatility.commands.Command.html#register_options">register_options</a></td>
    <td><span>Registers options into a config object provided</span></td>
  </tr><tr class="baseclassmethod">
    
    
    <td>Class Method</td>
    <td><a href="volatility.commands.Command.html#help">help</a></td>
    <td><span>This function returns a string that will be displayed when a user lists available plugins.</span></td>
  </tr><tr class="basemethod">
    
    
    <td>Method</td>
    <td><a href="volatility.commands.Command.html#calculate">calculate</a></td>
    <td><span>This function is responsible for performing all calculations</span></td>
  </tr><tr class="basemethod">
    
    
    <td>Method</td>
    <td><a href="volatility.commands.Command.html#format_value">format_value</a></td>
    <td><span>Formats an individual field using the table formatting codes</span></td>
  </tr><tr class="basemethod">
    
    
    <td>Method</td>
    <td><a href="volatility.commands.Command.html#table_header">table_header</a></td>
    <td><span>Table header renders the title row of a table</span></td>
  </tr><tr class="basemethod">
    
    
    <td>Method</td>
    <td><a href="volatility.commands.Command.html#table_row">table_row</a></td>
    <td><span>Outputs a single row of a table</span></td>
  </tr><tr class="basemethod private">
    
    
    <td>Method</td>
    <td><a href="volatility.commands.Command.html#_formatlookup">_formatlookup</a></td>
    <td><span>Code to turn profile specific values into format specifications</span></td>
  </tr><tr class="basemethod private">
    
    
    <td>Method</td>
    <td><a href="volatility.commands.Command.html#_elide">_elide</a></td>
    <td><span>Adds three dots in the middle of a string if it is longer than length</span></td>
  </tr>
  
</table>
      
      
    </div>
    
    
    

    <div class="function">
  <a name="volatility.plugins.linux.common.AbstractLinuxCommand.__init__">
    
  </a>
  <a name="__init__">
    
  </a>
  <div class="functionHeader">
    
    def
    __init__(self, *args, **kwargs):
    
  </div>
  <div class="functionBody">
    <div class="interfaceinfo">overrides <a href="volatility.commands.Command.html#__init__">volatility.commands.Command.__init__</a></div><div class="interfaceinfo">overridden in <a href="volatility.plugins.linux.check_fops.linux_check_fop.html">volatility.plugins.linux.check_fops.linux_check_fop</a>, <a href="volatility.plugins.linux.dentry_cache.linux_dentry_cache.html">volatility.plugins.linux.dentry_cache.linux_dentry_cache</a>, <a href="volatility.plugins.linux.dump_map.linux_dump_map.html">volatility.plugins.linux.dump_map.linux_dump_map</a>, <a href="volatility.plugins.linux.find_file.linux_find_file.html">volatility.plugins.linux.find_file.linux_find_file</a>, <a href="volatility.plugins.linux.lsmod.linux_lsmod.html">volatility.plugins.linux.lsmod.linux_lsmod</a>, <a href="volatility.plugins.linux.mount_cache.linux_mount_cache.html">volatility.plugins.linux.mount_cache.linux_mount_cache</a>, <a href="volatility.plugins.linux.netstat.linux_netstat.html">volatility.plugins.linux.netstat.linux_netstat</a>, <a href="volatility.plugins.linux.pslist.linux_pslist.html">volatility.plugins.linux.pslist.linux_pslist</a>, <a href="volatility.plugins.linux.sk_buff_cache.linux_sk_buff_cache.html">volatility.plugins.linux.sk_buff_cache.linux_sk_buff_cache</a>, <a href="volatility.plugins.linux.tmpfs.linux_tmpfs.html">volatility.plugins.linux.tmpfs.linux_tmpfs</a>, <a href="volatility.plugins.linux.vma_cache.linux_vma_cache.html">volatility.plugins.linux.vma_cache.linux_vma_cache</a></div>
    <div>Constructor uses args as an initializer. It creates an instance
of OptionParser, populates the options, and finally parses the
command line. Options are stored in the self.opts attribute.<table class="fieldTable"></table></div>
  </div>
</div><div class="function">
  <a name="volatility.plugins.linux.common.AbstractLinuxCommand.profile">
    
  </a>
  <a name="profile">
    
  </a>
  <div class="functionHeader">
    @property<br />
    def
    profile(self):
    
  </div>
  <div class="functionBody">
    
    <div class="undocumented">Undocumented</div>
  </div>
</div><div class="function">
  <a name="volatility.plugins.linux.common.AbstractLinuxCommand.execute">
    
  </a>
  <a name="execute">
    
  </a>
  <div class="functionHeader">
    
    def
    execute(self, *args, **kwargs):
    
  </div>
  <div class="functionBody">
    <div class="interfaceinfo">overrides <a href="volatility.commands.Command.html#execute">volatility.commands.Command.execute</a></div>
    <div>Executes the plugin command.<table class="fieldTable"></table></div>
  </div>
</div><div class="function">
  <a name="volatility.plugins.linux.common.AbstractLinuxCommand.is_valid_profile">
    
  </a>
  <a name="is_valid_profile">
    
  </a>
  <div class="functionHeader">
    @staticmethod<br />
    def
    is_valid_profile(profile):
    
  </div>
  <div class="functionBody">
    <div class="interfaceinfo">overrides <a href="volatility.commands.Command.html#is_valid_profile">volatility.commands.Command.is_valid_profile</a></div>
    <div class="undocumented">Undocumented</div>
  </div>
</div><div class="function">
  <a name="volatility.plugins.linux.common.AbstractLinuxCommand.get_profile_symbol">
    
  </a>
  <a name="get_profile_symbol">
    
  </a>
  <div class="functionHeader">
    
    def
    get_profile_symbol(self, sym_name, nm_type='', sym_type='', module='kernel'):
    
  </div>
  <div class="functionBody">
    
    <div>Gets a symbol out of the profile
syn_name -&gt; name of the symbol
nm_tyes  -&gt; types as defined by 'nm' (man nm for examples)
sym_type -&gt; the type of the symbol (passing Pointer will provide auto deref)
module   -&gt; which module to get the symbol from, default is kernel, otherwise can be any name seen in 'lsmod'</p>
<p>Just a wrapper for AbstractLinuxProfile.get_symbol<table class="fieldTable"></table></div>
  </div>
</div><div class="function">
  <a name="volatility.plugins.linux.common.AbstractLinuxCommand.get_per_cpu_symbol">
    
  </a>
  <a name="get_per_cpu_symbol">
    
  </a>
  <div class="functionHeader">
    
    def
    get_per_cpu_symbol(self, sym_name, module='kernel'):
    
  </div>
  <div class="functionBody">
    
    <div class="undocumented">Undocumented</div>
  </div>
</div><div class="function">
  <a name="volatility.plugins.linux.common.AbstractLinuxCommand.get_task_start_time">
    
  </a>
  <a name="get_task_start_time">
    
  </a>
  <div class="functionHeader">
    
    def
    get_task_start_time(self, task):
    
  </div>
  <div class="functionBody">
    
    <div class="undocumented">Undocumented</div>
  </div>
</div><div class="function">
  <a name="volatility.plugins.linux.common.AbstractLinuxCommand.online_cpus">
    
  </a>
  <a name="online_cpus">
    
  </a>
  <div class="functionHeader">
    
    def
    online_cpus(self):
    
  </div>
  <div class="functionBody">
    
    <div class="undocumented">Undocumented</div>
  </div>
</div><div class="function">
  <a name="volatility.plugins.linux.common.AbstractLinuxCommand.walk_per_cpu_var">
    
  </a>
  <a name="walk_per_cpu_var">
    
  </a>
  <div class="functionHeader">
    
    def
    walk_per_cpu_var(self, per_var, var_type):
    
  </div>
  <div class="functionBody">
    
    <div class="undocumented">Undocumented</div>
  </div>
</div><div class="function">
  <a name="volatility.plugins.linux.common.AbstractLinuxCommand.ACTHZ">
    
  </a>
  <a name="ACTHZ">
    
  </a>
  <div class="functionHeader">
    
    def
    ACTHZ(self, CLOCK_TICK_RATE, HZ):
    
  </div>
  <div class="functionBody">
    
    <div class="undocumented">Undocumented</div>
  </div>
</div><div class="function">
  <a name="volatility.plugins.linux.common.AbstractLinuxCommand.SH_DIV">
    
  </a>
  <a name="SH_DIV">
    
  </a>
  <div class="functionHeader">
    
    def
    SH_DIV(self, NOM, DEN, LSH):
    
  </div>
  <div class="functionBody">
    
    <div class="undocumented">Undocumented</div>
  </div>
</div><div class="function">
  <a name="volatility.plugins.linux.common.AbstractLinuxCommand.TICK_NSEC">
    
  </a>
  <a name="TICK_NSEC">
    
  </a>
  <div class="functionHeader">
    
    def
    TICK_NSEC(self):
    
  </div>
  <div class="functionBody">
    
    <div class="undocumented">Undocumented</div>
  </div>
</div><div class="function">
  <a name="volatility.plugins.linux.common.AbstractLinuxCommand.get_time_vars">
    
  </a>
  <a name="get_time_vars">
    
  </a>
  <div class="functionHeader">
    
    def
    get_time_vars(self):
    
  </div>
  <div class="functionBody">
    
    <div>Sometime in 3.[3-5], Linux switched to a global timekeeper structure
This just figures out which is in use and returns the correct variables<table class="fieldTable"></table></div>
  </div>
</div><div class="function">
  <a name="volatility.plugins.linux.common.AbstractLinuxCommand.get_boot_time">
    
  </a>
  <a name="get_boot_time">
    
  </a>
  <div class="functionHeader">
    
    def
    get_boot_time(self):
    
  </div>
  <div class="functionBody">
    
    <div class="undocumented">Undocumented</div>
  </div>
</div><div class="function">
  <a name="volatility.plugins.linux.common.AbstractLinuxCommand.is_known_address">
    
  </a>
  <a name="is_known_address">
    
  </a>
  <div class="functionHeader">
    
    def
    is_known_address(self, addr, modules):
    
  </div>
  <div class="functionBody">
    
    <div class="undocumented">Undocumented</div>
  </div>
</div><div class="function">
  <a name="volatility.plugins.linux.common.AbstractLinuxCommand.verify_ops">
    
  </a>
  <a name="verify_ops">
    
  </a>
  <div class="functionHeader">
    
    def
    verify_ops(self, ops, op_members, modules):
    
  </div>
  <div class="functionBody">
    
    <div class="undocumented">Undocumented</div>
  </div>
</div>
    <address>
      <a href="index.html">API Documentation</a> for Volatility 2.2, generated by <a href="http://codespeak.net/~mwh/pydoctor/">pydoctor</a> at 2013-06-24 15:16:10.
    </address>
  </body>
</html>